haptic5.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef HAPTIC5_H
#define HAPTIC5_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_pwm.h"




#define HAPTIC5_REG_PRODUCT_NUM                 0x0000
#define HAPTIC5_REG_MAJOR_VER                   0x0002
#define HAPTIC5_REG_MINOR_VER                   0x0004
#define HAPTIC5_REG_SYSTEM_STATUS               0x1000
#define HAPTIC5_REG_SYSTEM_SETTINGS             0x1002
#define HAPTIC5_REG_OVER_TEMP_SETTINGS          0x1003
#define HAPTIC5_REG_CONT_MODE_REP_TIME          0x1004
#define HAPTIC5_REG_SYSTEM_CONTROL              0x1006
#define HAPTIC5_REG_HAPTIC_CONTROL              0x1007
#define HAPTIC5_REG_HBRIDGE_SETUP               0x2000
#define HAPTIC5_REG_PWM_FREQUENCY               0x20A0
#define HAPTIC5_REG_LRA_FREQUENCY               0x20A2
#define HAPTIC5_REG_AUTORESONANCE_BOFF          0x20A4
 // haptic5_reg



#define HAPTIC5_COM_PWM                         0
#define HAPTIC5_COM_I2C                         1
#define HAPTIC5_DEFAULT_COM                     HAPTIC5_COM_PWM

#define HAPTIC5_PRODUCT_NUM                     0x09B9

#define HAPTIC5_SYSTEM_SETTINGS_MODE_NORMAL     0x00
#define HAPTIC5_SYSTEM_SETTINGS_MODE_CONTINUOUS 0x80
#define HAPTIC5_SYSTEM_SETTINGS_MODE_MASK       0x80
#define HAPTIC5_SYSTEM_SETTINGS_TRIGGER_EDGE    0x00
#define HAPTIC5_SYSTEM_SETTINGS_TRIGGER_LEVEL   0x40
#define HAPTIC5_SYSTEM_SETTINGS_TRIGGER_MASK    0x40
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_0MS     0x00
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_512MS   0x04
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_1024MS  0x08
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_1536MS  0x0C
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_2048MS  0x10
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_2560MS  0x14
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_3072MS  0x18
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_3584MS  0x1C
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_4096MS  0x20
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_4608MS  0x24
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_5120MS  0x28
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_5632MS  0x2C
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_6144MS  0x30
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_6656MS  0x34
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_7168MS  0x38
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_7680MS  0x3C
#define HAPTIC5_SYSTEM_SETTINGS_TIMEOUT_MASK    0x3C
#define HAPTIC5_SYSTEM_SETTINGS_PWR_MODE_FAST   0x00
#define HAPTIC5_SYSTEM_SETTINGS_PWR_MODE_ULP    0x01
#define HAPTIC5_SYSTEM_SETTINGS_PWR_MODE_AUTO   0x02
#define HAPTIC5_SYSTEM_SETTINGS_PWR_MODE_MASK   0x03

#define HAPTIC5_SYSTEM_CONTROL_SOFT_RESET       0x02
#define HAPTIC5_SYSTEM_CONTROL_ACK_RESET        0x01

#define HAPTIC5_PWM_DEF_FREQ                    20000
#define HAPTIC5_PWM_DEF_DUTY                    0.0

#define HAPTIC5_DEVICE_ADDRESS_0                0x54
#define HAPTIC5_DEVICE_ADDRESS_1                0x40
#define HAPTIC5_DEVICE_ADDRESS_0_DEBUG          0x55
#define HAPTIC5_DEVICE_ADDRESS_1_DEBUG          0x41
 // haptic5_set



#define HAPTIC5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.trg = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.dir = MIKROBUS( mikrobus, MIKROBUS_CS );
 // haptic5_map // haptic5

typedef struct
{
    // Output pins
    digital_out_t trg;          
    digital_out_t rst;          
    digital_out_t dir;          
 
    // Modules
    pwm_t pwm;                  
    i2c_master_t i2c;           
 
    // PWM frequency
    uint32_t pwm_freq;          
 
    // I2C slave address
    uint8_t slave_address;      
 
} haptic5_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t pwm;             
 
    // Additional gpio pins
    pin_name_t trg;             
    pin_name_t rst;             
    pin_name_t dir;             
 
    // Static variable
    uint32_t dev_pwm_freq;      
    uint32_t i2c_speed;         
    uint8_t i2c_address;        
 
} haptic5_cfg_t;

typedef enum
{
    HAPTIC5_OK = 0,
    HAPTIC5_ERROR = -1
 
} haptic5_return_value_t;


void haptic5_cfg_setup ( haptic5_cfg_t *cfg );

err_t haptic5_init ( haptic5_t *ctx, haptic5_cfg_t *cfg );

err_t haptic5_default_cfg ( haptic5_t *ctx );
 
#if ( HAPTIC5_DEFAULT_COM == HAPTIC5_COM_I2C )

err_t haptic5_write_regs ( haptic5_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len );

err_t haptic5_read_regs ( haptic5_t *ctx, uint16_t reg, uint8_t *data_out, uint8_t len );

err_t haptic5_write_reg_byte ( haptic5_t *ctx, uint16_t reg, uint8_t data_in );

err_t haptic5_read_reg_byte ( haptic5_t *ctx, uint16_t reg, uint8_t *data_out );

err_t haptic5_write_reg_word ( haptic5_t *ctx, uint16_t reg, uint16_t data_in );

err_t haptic5_read_reg_word ( haptic5_t *ctx, uint16_t reg, uint16_t *data_out );

err_t haptic5_check_communication ( haptic5_t *ctx );

void haptic5_set_trg_low ( haptic5_t *ctx );

void haptic5_set_trg_high ( haptic5_t *ctx );
 
#else

err_t haptic5_set_duty_cycle ( haptic5_t *ctx, float duty_cycle );

err_t haptic5_pwm_stop ( haptic5_t *ctx );

err_t haptic5_pwm_start ( haptic5_t *ctx );

void haptic5_set_dir_forward ( haptic5_t *ctx );

void haptic5_set_dir_reverse ( haptic5_t *ctx );

void haptic5_toggle_dir ( haptic5_t *ctx );
 
#endif

void haptic5_enable_device ( haptic5_t *ctx );

void haptic5_disable_device ( haptic5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HAPTIC5_H
 // haptic5
 
// ------------------------------------------------------------------------ END